Vcenter VM FilterSpec

The Vcenter VM FilterSpec schema contains properties used to filter the results when listing virtual machines (see GET /vcenter/vm). If multiple properties are specified, only virtual machines matching all of the properties match the filter.

JSON Example

{
    "vms": [
        "string"
    ],
    "names": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "datacenters": [
        "string"
    ],
    "hosts": [
        "string"
    ],
    "clusters": [
        "string"
    ],
    "resource_pools": [
        "string"
    ],
    "power_states": [
        "string"
    ]
}

array of string

vms

Optional

Identifiers of virtual machines that can match the filter.

If missing or null or empty, virtual machines with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: VirtualMachine.

array of string

names

Optional

Names that virtual machines must have to match the filter (see Vcenter VM Info.name).

If missing or null or empty, virtual machines with any name match the filter.

array of string

folders

Optional

Folders that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

array of string

datacenters

Optional

Datacenters that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

array of string

hosts

Optional

Hosts that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines on any host match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string

clusters

Optional

Clusters that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any cluster match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

array of string

resource_pools

Optional

Resource pools that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any resource pool match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ResourcePool.

array of string

power_states

Optional

Power states that a virtual machine must be in to match the filter (see Vcenter Vm Power Info.state.

For more information see: Vcenter Vm Power State.

If missing or null or empty, virtual machines in any power state match the filter.